Api.ReadAxisActualPosition method

Reads the current position from an axis using the primary encoder.

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

C#VB

public KsReturn<int> ReadAxisActualPosition(
       int Index
)

Public Function ReadAxisActualPosition(
       Index As Integer
) As KsReturn(Of Integer)

Parameters

Index

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

Return value

Returns a KsError code and an integer value.

Remarks

Used in the cyclic callback to check the actual position of an axis.

Usable EtherCAT states

ecatOP

Examples

N/A